Extending Dreamweaver Overview

The Document Object Model and JavaScript

Objects

Commands

Menu Commands

Reports

JavaScript Debugger Modules

Property Inspectors

Floating Panels

Behaviors

The Fireworks Integration API

The Flash Objects API

The Design Notes API

The File I/O API

The HTTP API

The Database API

The JavaBean API

The Source Control Integration API

C-Level Extensibility

The Dreamweaver JavaScript API
  The JavaScript API overview
  Understanding the objects in the API
  About enablers
  How this chapter is organized
  Getting document data through the DOM
  dreamweaver.getDocumentDOM()
  Assets panel functions
  dreamweaver.assetPalette.addToFavoritesFromDocument()
  dreamweaver.assetPalette.addToFavoritesFromSiteAssets()
  dreamweaver.assetPalette.addToFavoritesFromSiteWindow()
  dreamweaver.assetPalette.copyToSite()
  dreamweaver.assetPalette.edit()
  dreamweaver.assetPalette.getSelectedCategory()
  dreamweaver.assetPalette.getSelectedItems()
  dreamweaver.assetPalette.getSelectedView()
  dreamweaver.assetPalette.insertOrApply()
  dreamweaver.assetPalette.locateInSite()
  dreamweaver.assetPalette.newAsset()
  dreamweaver.assetPalette.newFolder()
  dreamweaver.assetPalette.recreateLibraryFromDocument()
  dreamweaver.assetPalette.refreshSiteAssets()
  dreamweaver.assetPalette.removeFromFavorites()
  dreamweaver.assetPalette.renameNickname()
  dreamweaver.assetPalette.setSelectedCategory()
  dreamweaver.assetPalette.setSelectedView()
  dreamweaver.referencePalette.getFontSize()
  dreamweaver.referencePalette.setFontSize()
  Behavior functions
  dom.addBehavior()
  dom.getBehavior()
  dom.reapplyBehaviors()
  dom.removeBehavior()
  dreamweaver.getBehaviorElement()
  dreamweaver.getBehaviorTag()
  dreamweaver.popupAction()
  dreamweaver.behaviorInspector.getBehaviorAt()
  dreamweaver.behaviorInspector.getBehaviorCount()
  dreamweaver.behaviorInspector.getSelectedBehavior()
  dreamweaver.behaviorInspector.moveBehaviorDown()
  dreamweaver.behaviorInspector.moveBehaviorUp()
  dreamweaver.behaviorInspector.setSelectedBehavior()
  Clipboard functions
  dom.clipCopy()
  dom.clipCopyText()
  dom.clipCut()
  dom.clipPaste()
  dom.clipPasteText()
  dreamweaver.clipCopy()
  dreamweaver.clipCut()
  dreamweaver.clipPaste()
  dreamweaver.getClipboardText()
  Command functions
  dreamweaver.editCommandList()
  dreamweaver.runCommand()
  Conversion functions
  dom.convertLayersToTable()
  dom.convertTablesToLayers()
  dom.convertTo30()
  CSS style functions
  dom.removeCSSStyle()
  dreamweaver.stylePalette.attachExternalStylesheet()
  dreamweaver.cssStylePalette.deleteSelectedStyle()
  dreamweaver.cssStylePalette.duplicateSelectedStyle()
  dreamweaver.cssStylePalette.editSelectedStyle()
  dreamweaver.cssStylePalette.editStyleSheet()
  dreamweaver.cssStylePalette.getSelectedStyle()
  dreamweaver.cssStylePalette.getSelectedTarget()
  dreamweaver.cssStylePalette.getStyles()
  dreamweaver.cssStylePalette.newStyle()
  External application functions
  dreamweaver.browseDocument()
  dreamweaver.getBrowserList()
  dreamweaver.getExtensionEditorList()
  dreamweaver.getExternalTextEditor()
  dreamweaver.getPrimaryBrowser()
  dreamweaver.getPrimaryExtensionEditor()
  dreamweaver.getSecondaryBrowser()
  dreamweaver.openWithApp()
  dreamweaver.openWithBrowseDialog()
  dreamweaver.openWithExternalTextEditor()
  dreamweaver.openWithImageEditor()
  File manipulation functions
  dreamweaver.browseForFileURL()
  dreamweaver.browseForFolderURL()
  dreamweaver.closeDocument()
  dreamweaver.createDocument()
  dreamweaver.exportCSS()
  dreamweaver.exportEditableRegionsAsXML()
  dreamweaver.getRecentFileList()
  dreamweaver.importXMLIntoTemplate()
  dreamweaver.newFromTemplate()
  dreamweaver.openDocument()
  dreamweaver.openDocumentFromSite()
  dreamweaver.openInFrame()
  dreamweaver.releaseDocument()
  dreamweaver.revertDocument()
  dreamweaver.saveAll()
  dreamweaver.saveDocument()
  dreamweaver.saveDocumentAs()
  dreamweaver.saveDocumentAsTemplate()
  dreamweaver.saveFrameset()
  dreamweaver.saveFramesetAs()
  Find/replace functions
  dreamweaver.findNext()
  dreamweaver.replace()
  dreamweaver.replaceAll()
  dreamweaver.setUpComplexFind()
  dreamweaver.setUpComplexFindReplace()
  dreamweaver.setUpFind()
  dreamweaver.setUpFindReplace()
  dreamweaver.showFindDialog()
  dreamweaver.showFindReplaceDialog()
  Frame and frameset functions
  dom.getFrameNames()
  dom.isDocumentInFrame()
  dom.saveAllFrames()
  dom.splitFrame()
  General editing functions
  dom.applyCharacterMarkup()
  dom.applyFontMarkup()
  dom.deleteSelection()
  dom.editAttribute()
  dom.exitBlock()
  dom.getCharSet()
  dom.getFontMarkup()
  dom.getLinkHref()
  dom.getLinkTarget()
  dom.getListTag()
  dom.getTextAlignment()
  dom.getTextFormat()
  dom.hasCharacterMarkup()
  dom.indent()
  dom.insertHTML()
  dom.insertObject()
  dom.insertText()
  dom.newBlock()
  dom.notifyFlashObjectChanged()
  dom.outdent()
  dom.removeCharacterMarkup()
  dom.removeFontMarkup()
  dom.removeLink()
  dom.resizeSelection()
  dom.setAttributeWithErrorChecking()
  dom.setLinkHref()
  dom.setLinkTarget()
  dom.setListBoxKind()
  dom.showListPropertiesDialog()
  dom.setListTag()
  dom.setTextAlignment()
  dom.setTextFieldKind()
  dom.showFontColorDialog()
  dreamweaver.deleteSelection()
  dreamweaver.editFontList()
  dreamweaver.getFontList()
  dreamweaver.getFontStyles()
  dreamweaver.getKeyState()
  dreamweaver.getSystemFontList()
  Global application functions
  dreamweaver.getShowDialogsOnInsert()
  dreamweaver.quitApplication()
  dreamweaver.showAboutBox()
  dreamweaver.showPreferencesDialog()
  Global document functions
  dom.checkSpelling()
  dom.checkTargetBrowsers()
  dom.showPagePropertiesDialog()
  dreamweaver.getElementRef()
  History functions
  dom.redo()
  dom.undo()
  dreamweaver.getRedoText()
  dreamweaver.getUndoText()
  dreamweaver.playRecordedCommand()
  dreamweaver.redo()
  dreamweaver.startRecording()
  dreamweaver.stopRecording()
  dreamweaver.undo()
  dreamweaver.historyPalette.clearSteps()
  dreamweaver.historyPalette.copySteps()
  dreamweaver.historyPalette.getSelectedSteps()
  dreamweaver.historyPalette.getStepCount()
  dreamweaver.historyPalette.getStepsAsJavaScript()
  dreamweaver.historyPalette.getUndoState()
  dreamweaver.historyPalette.replaySteps()
  dreamweaver.historyPalette.saveAsCommand()
  dreamweaver.historyPalette.setSelectedSteps()
  dreamweaver.historyPalette.setUndoState()
  HTML style functions
  dom.applyHTMLStyle()
  dreamweaver.htmlStylePalette.deleteSelectedStyle()
  dreamweaver.htmlStylePalette.duplicateSelectedStyle()
  dreamweaver.htmlStylePalette.editSelectedStyle()
  dreamweaver.htmlStylePalette.getSelectedStyle()
  dreamweaver.htmlStylePalette.getStyles()
  dreamweaver.htmlStylePalette.newStyle()
  dreamweaver.htmlStylePalette.setSelectedStyle()
  JavaScript Debugger functions
  dom.instrumentDocument ()
  dreamweaver.debugDocument()
  dreamweaver.getDebugBrowserList()
  dreamweaver.getIsAnyBreakpoints()
  dreamweaver.removeAllBreakpoints()
  dreamweaver.startDebugger()
  Keyboard functions
  dom.arrowDown()
  dom.arrowLeft()
  dom.arrowRight()
  dom.arrowUp()
  dom.backspaceKey()
  dom.deleteKey()
  dom.endOfDocument()
  dom.endOfLine()
  dom.nextParagraph()
  dom.nextWord()
  dom.pageDown()
  dom.pageUp()
  dom.previousParagraph()
  dom.previousWord()
  dom.startOfDocument()
  dom.startOfLine()
  mapKeyCodeToChar()
  Layer and image map functions
  dom.align()
  dom.arrange()
  dom.makeSizesEqual()
  dom.moveSelectionBy()
  dom.resizeSelectionBy()
  dom.setLayerTag()
  Library and template functions
  dom.applyTemplate()
  dom.detachFromLibrary()
  dom.detachFromTemplate()
  dom.getAttachedTemplate()
  dom.getEditableRegionList()
  dom.getIsLibraryDocument()
  dom.getIsTemplateDocument()
  dom.getSelectedEditableRegion()
  dom.insertLibraryItem()
  dom.markSelectionAsEditable()
  dom.newEditableRegion()
  dom.removeEditableRegion()
  dom.updateCurrentPage()
  dreamweaver.updatePages()
  dreamweaver.templatePalette.newBlankTemplate()
  Menu functions
  dreamweaver.getMenuNeedsUpdating()
  dreamweaver.notifyMenuUpdated()
  dreamweaver.reloadMenus()
  Path functions
  dreamweaver.getConfigurationPath()
  dreamweaver.getDocumentPath()
  dreamweaver.getSiteRoot()
  dreamweaver.relativeToAbsoluteURL()
  Quick Tag Editor functions
  dom.selectChild()
  dom.selectParent()
  dom.stripTag()
  dom.wrapTag()
  dreamweaver.showQuickTagEditor()
  Report functions
  dreamweaver.isReporting()
  dreamweaver.showReportsDialog()
  dreamweaver.results.setResultData()
  Results window functions
  dreamweaver.createResultsWindow()
  resWin.addItem()
  resWin.setCallbackCommands()
  resWin.setColumnWidths()
  resWin.setFileList()
  resWin.setTitle()
  resWin.startProcessing()
  resWin.stopProcessing()
  Selection functions
  dom.getSelectedNode()
  dom.getSelection()
  dom.nodeToOffsets()
  dom.offsetsToNode()
  dom.selectAll()
  dom.selectTable()
  dom.setSelectedNode()
  dom.setSelection()
  dreamweaver.selectAll()
  Site functions
  dreamweaver.loadSitesFromPrefs()
  dreamweaver.saveSitesToPrefs()
  site.addLinkToExistingFile()
  site.addLinkToNewFile()
  site.canEditColumns()
  site.changeLinkSitewide()
  site.changeLink()
  site.checkIn()
  site.checkLinks()
  site.checkOut()
  site.checkTargetBrowsers()
  site.defineSites()
  site.deleteSelection()
  site.editColumns()
  site.locateInSite()
  site.findLinkSource()
  site.get()
  site.getCheckOutUser()
  site.getCheckOutUserForFile()
  site.getConnectionState()
  site.getCurrentSite()
  site.getFocus()
  site.getLinkVisibility()
  site.getSelection()
  site.getSites()
  site.invertSelection()
  site.makeEditable()
  site.makeNewDreamweaverFile()
  site.makeNewFolder()
  site.newHomePage()
  site.newSite()
  site.open()
  site.put()
  site.recreateCache()
  site.refresh()
  site.remoteIsValid()
  site.removeLink()
  site.renameSelection()
  site.saveAsImage()
  site.selectAll()
  site.selectHomePage()
  site.selectNewer()
  site.setAsHomePage()
  site.setConnectionState()
  site.setCurrentSite()
  site.setFocus()
  site.setLayout()
  site.setLinkVisibility()
  site.setSelection()
  site.synchronize()
  site.undoCheckOut()
  site.viewAsRoot()
  Source View functions
  dom.isDesignViewUpdated()
  dom.isSelectionValid()
  dom.source.arrowDown()
  dom.source.arrowLeft()
  dom.source.arrowRight()
  dom.source.arrowUp()
  dom.source.balanceBracesTextView()
  dom.source.endOfDocument()
  dom.source.endOfLine()
  dom.source.endPage()
  dom.source.getCurrentLines()
  dom.source.getSelection()
  dom.source.getText()
  dom.source.indentTextView()
  dom.source.insert()
  dom.source.nextWord()
  dom.source.outdentTextView()
  dom.source.pageDown()
  dom.source.pageUp()
  dom.source.previousWord()
  dom.source.replaceRange()
  dom.source.scrollEndFile()
  dom.source.scrollLineDown()
  dom.source.scrollLineUp()
  dom.source.scrollPageDown()
  dom.source.scrollPageUp()
  dom.source.scrollTopFile()
  dom.source.selectParentTag()
  dom.source.setCurrentLine()
  dom.source.startOfDocument()
  dom.source.startOfLine()
  dom.source.topPage()
  dom.source.wrapSelection()
  dom.synchronizeDocument()
  String manipulation functions
  dreamweaver.doURLEncoding()
  dreamweaver.getTokens()
  dreamweaver.latin1ToNative()
  dreamweaver.nativeToLatin1()
  dreamweaver.scanSourceString()
  Table editing functions
  dom.convertWidthsToPercent()
  dom.convertWidthsToPixels()
  dom.decreaseColspan()
  dom.decreaseRowspan()
  dom.deleteTableColumn()
  dom.deleteTableRow()
  dom.doDeferredTableUpdate()
  dom.getTableExtent()
  dom.increaseColspan()
  dom.increaseRowspan()
  dom.insertTableColumns()
  dom.insertTableRows()
  dom.mergeTableCells()
  dom.removeAllTableHeights()
  dom.removeAllTableWidths()
  dom.setTableCellTag()
  dom.setTableColumns()
  dom.setTableRows()
  dom.showInsertTableRowsOrColumnsDialog()
  dom.splitTableCell()
  Timeline functions
  dreamweaver.timelineInspector.addBehavior()
  dreamweaver.timelineInspector.addFrame()
  dreamweaver.timelineInspector.addKeyframe()
  dreamweaver.timelineInspector.addObject()
  dreamweaver.timelineInspector.addTimeline()
  dreamweaver.timelineInspector.changeObject()
  dreamweaver.timelineInspector.getAutoplay()
  dreamweaver.timelineInspector.getCurrentFrame()
  dreamweaver.timelineInspector.getLoop()
  dreamweaver.timelineInspector.recordPathOfLayer()
  dreamweaver.timelineInspector.removeBehavior()
  dreamweaver.timelineInspector.removeFrame()
  dreamweaver.timelineInspector.removeKeyframe()
  dreamweaver.timelineInspector.removeObject()
  dreamweaver.timelineInspector.removeTimeline()
  dreamweaver.timelineInspector.renameTimeline()
  dreamweaver.timelineInspector.setAutoplay()
  dreamweaver.timelineInspector.setCurrentFrame()
  dreamweaver.timelineInspector.setLoop()
  Toggle functions
  dom.getEditNoFramesContent()
  dom.getHideAllVisualAids()
  dom.getPreventLayerOverlaps()
  dom.getShowAutoIndent()
  dom.getShowFrameBorders()
  dom.getShowGrid()
  dom.getShowHeadView()
  dom.getShowHighlightInvalidHTML()
  dom.getShowImageMaps()
  dom.getShowInvisibleElements()
  dom.getShowLayerBorders()
  dom.getShowLineNumbers()
  dom.getShowRulers()
  dom.getShowSyntaxColoring()
  dom.getShowTableBorders()
  dom.getShowToolbar()
  dom.getShowTracingImage()
  dom.getShowWordWrap()
  dom.getSnapToGrid()
  dom.setEditNoFramesContent()
  dom.setHideAllVisualAids()
  dom.setPreventLayerOverlaps()
  dom.setShowFrameBorders()
  dom.setShowGrid()
  dom.setShowHeadView()
  dom.setShowHighlightInvalidHTML()
  dom.setShowImageMaps()
  dom.setShowInvisibleElements()
  dom.setShowLayerBorders()
  dom.setShowLineNumbers()
  dom.setShowRulers()
  dom.setShowSyntaxColoring()
  dom.setShowTableBorders()
  dom.setShowToolbar()
  dom.setShowTracingImage()
  dom.setShowWordWrap()
  dom.setSnapToGrid()
  dreamweaver.getHideAllFloaters()
  dreamweaver.getShowStatusBar()
  dreamweaver.htmlInspector.getShowAutoIndent()
  dreamweaver.htmlInspector.getShowHighlightInvalidHTML()
  dreamweaver.htmlInspector.getShowLineNumbers()
  dreamweaver.htmlInspector.getShowSyntaxColoring()
  dreamweaver.htmlInspector.getShowWordWrap()
  dreamweaver.htmlInspector.setShowAutoIndent()
  dreamweaver.htmlInspector.setShowHighlightInvalidHTML()
  dreamweaver.htmlInspector.setShowLineNumbers()
  dreamweaver.htmlInspector.setShowSyntaxColoring()
  dreamweaver.htmlInspector.setShowWordWrap()
  dreamweaver.setHideAllFloaters()
  dreamweaver.setShowStatusBar()
  site.getShowDependents()
  site.getShowHiddenFiles()
  site.getShowPageTitles()
  site.getShowToolTips()
  site.setShowDependents()
  site.setShowHiddenFiles()
  site.setShowPageTitles()
  site.setShowToolTips()
  Translation functions
  dom.runTranslator()
  dreamweaver.editLockedRegions()
  dreamweaver.getTranslatorList()
  dreamweaver.useTranslatedSource()
  Layout environment functions
  dom.getRulerOrigin()
  dom.getRulerUnits()
  dom.getTracingImageOpacity()
  dom.loadTracingImage()
  dom.playAllPlugins()
  dom.playPlugin()
  dom.setRulerOrigin()
  dom.setRulerUnits()
  dom.setTracingImagePosition()
  dom.setTracingImageOpacity()
  dom.snapTracingImageToSelection()
  dom.stopAllPlugins()
  dom.stopPlugin()
  dreamweaver.arrangeFloatingPalettes()
  dreamweaver.showGridSettingsDialog()
  Layout view functions
  dom.addSpacerToColumn()
  dom.createLayoutCell()
  dom.createLayoutTable()
  dom.doesColumnHaveSpacer()
  dom.doesGroupHaveSpacers()
  dom.getClickedHeaderColumn()
  dom.getShowLayoutTableTabs()
  dom.getShowLayoutView()
  dom.isColumnAutostretch()
  dom.makeCellWidthsConsistent()
  dom.removeAllSpacers()
  dom.removeSpacerFromColumn()
  dom.setColumnAutostretch()
  dom.setShowLayoutTableTabs()
  dom.setShowLayoutView()
  Window functions
  dom.getFocus()
  dom.getView()
  dom.getWindowTitle()
  dom.setView()
  dreamweaver.getActiveWindow()
  dreamweaver.getDocumentList()
  dreamweaver.getFloaterVisibility()
  dreamweaver.getFocus()
  dreamweaver.getPrimaryView()
  dreamweaver.getSnapDistance()
  dreamweaver.minimizeRestoreAll()
  dreamweaver.setActiveWindow()
  dreamweaver.setFloaterVisibility()
  dreamweaver.setPrimaryView()
  dreamweaver.setSnapDistance()
  dreamweaver.showProperties()
  dreamweaver.toggleFloater()
  dreamweaver.updateReference()
  Deprecated functions
  dreamweaver.getBehaviorEvent()
  dreamweaver.getObjectRefs()
  dreamweaver.getObjectTags()
  dreamweaver.getSelection()
  dreamweaver.libraryPalette.deleteSelectedItem()
  dreamweaver.libraryPalette.getSelectedItem()
  dreamweaver.libraryPalette.newFromDocument()
  dreamweaver.libraryPalette.recreateFromDocument()
  dreamweaver.libraryPalette.renameSelectedItem()
  dreamweaver.nodeToOffsets()
  dreamweaver.templatePalette.getSelectedTemplate()
  dreamweaver.offsetsToNode()
  dreamweaver.popupCommand()
  dreamweaver.setSelection()
  dreamweaver.templatePalette.deleteSelectedTemplate()
  dreamweaver.templatePalette.renameSelectedTemplate()
  Enablers
  dom.canAlign()
  dom.canApplyTemplate()
  dom.canArrange()
  dom.canClipCopyText()
  dom.canClipPaste()
  dom.canClipPasteText()
  dom.canConvertLayersToTable()
  dom.canConvertTablesToLayers()
  dom.canDecreaseColspan()
  dom.canDecreaseRowspan()
  dom.canDeleteTableColumn()
  dom.canDeleteTableRow()
  dom.canEditNoFramesContent()
  dom.canIncreaseColspan()
  dom.canIncreaseRowspan()
  dom.canInsertTableColumns()
  dom.canInsertTableRows()
  dom.canMakeNewEditableRegion()
  dom.canMarkSelectionAsEditable()
  dom.canMergeTableCells()
  dom.canPlayPlugin()
  dom.canRedo()
  dom.canRemoveEditableRegion()
  dom.canSelectTable()
  dom.canSetLinkHref()
  dom.canShowListPropertiesDialog()
  dom.canSplitFrame()
  dom.canSplitTableCell()
  dom.canStopPlugin()
  dom.canUndo()
  dom.hasTracingImage()
  dreamweaver.assetPalette.canEdit()
  dreamweaver.assetPalette.canInsertOrApply()
  dreamweaver.canClipCopy()
  dreamweaver.canClipCut()
  dreamweaver.canClipPaste()
  dreamweaver.canDeleteSelection()
  dreamweaver.canExportCSS()
  dreamweaver.canFindNext()
  dreamweaver.canOpenInFrame()
  dreamweaver.canPlayRecordedCommand()
  dreamweaver.canRedo()
  dreamweaver.canRevertDocument()
  dreamweaver.canSaveAll()
  dreamweaver.canSaveDocument()
  dreamweaver.canSaveDocumentAsTemplate()
  dreamweaver.canSaveFrameset()
  dreamweaver.canSaveFramesetAs()
  dreamweaver.canSelectAll()
  dreamweaver.canShowFindDialog()
  dreamweaver.canUndo()
  dreamweaver.isRecording()
  dreamweaver.htmlStylePalette.canEditSelection()
  dreamweaver.timelineInspector.canAddFrame()
  dreamweaver.timelineInspector.canAddKeyFrame()
  dreamweaver.timelineInspector.canChangeObject()
  dreamweaver.timelineInspector.canRemoveBehavior()
  dreamweaver.timelineInspector.canRemoveFrame()
  dreamweaver.timelineInspector.canRemoveKeyFrame()
  dreamweaver.timelineInspector.canRemoveObject()
  site.browseDocument()
  site.canAddLink()
  site.canChangeLink()
  site.canCheckIn()
  site.canCheckOut()
  site.canConnect()
  site.canFindLinkSource()
  site.canGet()
  site.canLocateInSite()
  site.canMakeEditable()
  site.canMakeNewFileOrFolder()
  site.canOpen()
  site.canPut()
  site.canRecreateCache()
  site.canRefresh()
  site.canRemoveLink()
  site.canSetLayout()
  site.canSelectAllCheckedOutFiles()
  site.canSelectNewer()
  site.canShowPageTitles()
  site.canSynchronize()
  site.canUndoCheckOut()
  site.canViewAsRoot()
  site.SelectAllCheckedOutFiles()

Extending Dreamweaver Help Credits